/*
 * JBoss, Home of Professional Open Source
 * Copyright 2015, Red Hat, Inc. and/or its affiliates, and individual
 * contributors by the @authors tag. See the copyright.txt in the
 * distribution for a full listing of individual contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jboss.as.quickstarts.tasksJsf;

import java.util.List;

/**
 * <p>
 * Operations with cached list of tasks for current user.
 * </p>
 *
 * <p>
 * Implementation needs to preserve contracts for {@link #getAll()} and {@link #invalidate()}.
 * </p>
 *
 * @author Lukas Fryc
 *
 */
public interface TaskList {

    /**
     * <p>
     * Obtains list of tasks for current user.
     * </p>
     *
     * <p>
     * Caches current value; cache can be invalidated using {@link #invalidate()}.
     *
     * <p>
     * Delegates to persistence layer at most once per request or once per call of {@link #invalidate()}.
     * </p>
     *
     * @return
     */
    List<Task> getAll();

    /**
     * Invalidates all caches which this lists holds.
     */
    void invalidate();
}
